Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: Kedro-Viz React component usage #1954

Closed
wants to merge 36 commits into from
Closed

Documentation: Kedro-Viz React component usage #1954

wants to merge 36 commits into from

Conversation

jitu5
Copy link
Contributor

@jitu5 jitu5 commented Jun 24, 2024 •
edited
Loading

Resolves #1745

This PR introduces detailed documentation on how to use the Kedro-Viz React component. The following changes have been made:

  • README.md Relocation: Existing README.md file has been moved to the .github folder.
  • NPM-Specific README.md: README.npm.md is created at root to be used specifically for NPM.
  • New Repository: A new kedro-viz-standalone repository has been created under the kedro-org.
  • Documentation Update: A new section, "As a standalone React component," has been added to the Kedro-Viz documentation.
  • Props Explanation: Detailed props explanation has been kept in the README.md for NPM.
  • UI Component Annotation: A Kedro-Viz UI component annotation screenshot has been added.
  • Github Actions: In release.yml under release_to_npm job, new step added to rename README.npm.md to README.md before npm publish step.

Note: Before merge please update url of annotation image and change kedro-viz-standalone repository visibility to public.

Reference of README.md from my personal repository of Kedro-viz:
Github: https://github.com/jitu5/kedro-viz
NPM: https://www.npmjs.com/package/kedro-vizzz

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added new entries to the RELEASE.md file
  • Added tests to cover my changes

jitu5 and others added 5 commits June 21, 2024 20:09
@jitu5
Kedro viz as react component documentation
bae3962 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Viz doc added
b04bfed 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Standalone Example Repository section added
6444897 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
save file details added
ac80476 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Merge branch 'main' into doc/react-component
badef39
@jitu5 jitu5 self-assigned this Jun 24, 2024
@jitu5
Section rearrangement
3f320de 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
README.md file path is changed for PyPI
a935cc1 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
astrojuanlu
astrojuanlu reviewed Jun 24, 2024
View reviewed changes
package/setup.py Outdated Show resolved Hide resolved
@jitu5 jitu5 marked this pull request as ready for review June 24, 2024 15:49
Huongg
Huongg reviewed Jun 26, 2024
View reviewed changes
.github/README.md Outdated Show resolved Hide resolved
jitu5 and others added 2 commits June 28, 2024 10:56
@jitu5
Restoring existing README.md to root
f5e4ab4 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Merge branch 'main' into doc/react-component
0fba958
ravi-kumar-pilla
ravi-kumar-pilla reviewed Jun 28, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
ravi-kumar-pilla
ravi-kumar-pilla reviewed Jun 28, 2024
View reviewed changes
README.npm.md Outdated Show resolved Hide resolved
ravi-kumar-pilla
ravi-kumar-pilla reviewed Jun 28, 2024
View reviewed changes
README.npm.md Outdated Show resolved Hide resolved
ravi-kumar-pilla
ravi-kumar-pilla reviewed Jun 28, 2024
View reviewed changes
README.npm.md Outdated Show resolved Hide resolved
ravi-kumar-pilla
ravi-kumar-pilla reviewed Jun 28, 2024
View reviewed changes
README.npm.md Outdated Show resolved Hide resolved
jitu5 added 2 commits July 1, 2024 11:40
@jitu5
Code review suggestion
e49ebc6 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
preview removed
083d5a6 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
ravi-kumar-pilla
ravi-kumar-pilla approved these changes Jul 1, 2024
View reviewed changes
Copy link
Contributor

@ravi-kumar-pilla ravi-kumar-pilla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ! Thank you @jitu5

astrojuanlu
astrojuanlu approved these changes Jul 1, 2024
View reviewed changes
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

tynandebold
tynandebold approved these changes Jul 1, 2024
View reviewed changes
Copy link
Member

@tynandebold tynandebold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, Jitendra! Well done. Approved.

Left a couple small suggestions and one question.

.github/img/kedro_viz_annotation.png Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

README.md Outdated Show resolved Hide resolved
README.npm.md Outdated Show resolved Hide resolved
README.npm.md Show resolved Hide resolved
jitu5 and others added 4 commits July 2, 2024 17:24
@jitu5
Parent div element as wrapper added
1bbe9c5 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Merge branch 'main' into doc/react-component
d8d75ae
@jitu5 @tynandebold
Update README.md
f3d2cd8 
Co-authored-by: Tynan DeBold <thdebold@gmail.com>
Signed-off-by: Jitendra Gundaniya <38945204+jitu5@users.noreply.github.com>
@jitu5 @tynandebold
Update README.npm.md
2215cc1 
Co-authored-by: Tynan DeBold <thdebold@gmail.com>
Signed-off-by: Jitendra Gundaniya <38945204+jitu5@users.noreply.github.com>
jitu5 and others added 5 commits July 10, 2024 10:41
@jitu5
Merge branch 'main' into doc/react-component
7764e5f
@jitu5
Rebuild
ab8798e 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Fix doc build error
7d95668 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
comment removed
2fe1029 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
code block type changed to jsx
e9f45bd 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
Huongg
Huongg approved these changes Jul 10, 2024
View reviewed changes
Copy link
Contributor

@Huongg Huongg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the changes look good to me, thank you @jitu5

rashidakanchwala
rashidakanchwala approved these changes Jul 10, 2024
View reviewed changes
Copy link
Contributor

@rashidakanchwala rashidakanchwala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome. Thank you!!

@jitu5
annotation image update
18e6b1d 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Props updated
0446855 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
kedro viz annotation updates
f0a3645 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Docs updated as pre new refactor work
52c7137 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
annotation image updated
8a45d32 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Merge branch 'main' into doc/react-component
f37560e 
# Conflicts:
#	README.md
#	README.md~HEAD
@jitu5
README.md conflict resolved
83bd6f8 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
@jitu5
Doc copy changes.
b8bb951
@jitu5 jitu5 mentioned this pull request Jul 19, 2024
Merged
5 tasks
ravi-kumar-pilla
ravi-kumar-pilla approved these changes Jul 19, 2024
View reviewed changes
Copy link
Contributor

@ravi-kumar-pilla ravi-kumar-pilla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !! Thank you

@jitu5
Rearrange props in alphabetical order
939e78d 
Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com>
astrojuanlu
astrojuanlu approved these changes Jul 22, 2024
View reviewed changes
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-approving this 🔥 Ship ittttttt

@rashidakanchwala
Copy link
Contributor

@jitu5
Copy link
Contributor Author

jitu5 commented Jul 22, 2024

Closing this PR as it already merged with #1992 to main.

@jitu5 jitu5 closed this Jul 22, 2024
@SajidAlamQB SajidAlamQB mentioned this pull request Jul 25, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ravi-kumar-pilla ravi-kumar-pilla ravi-kumar-pilla approved these changes

@astrojuanlu astrojuanlu astrojuanlu approved these changes

@stephkaiser stephkaiser Awaiting requested review from stephkaiser

@tynandebold tynandebold Awaiting requested review from tynandebold

@rashidakanchwala rashidakanchwala Awaiting requested review from rashidakanchwala rashidakanchwala is a code owner

@Huongg Huongg Awaiting requested review from Huongg

Assignees

@jitu5 jitu5

Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document Kedro-Viz React component usage
6 participants
@jitu5 @astrojuanlu @rashidakanchwala @tynandebold @Huongg @ravi-kumar-pilla